home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 #2 / Ham Radio 2000 - Volume 2.iso / HAMV2 / PACKET / UPDAT630 / TFTNCHLP.TXT < prev    next >
Text File  |  1997-08-19  |  11KB  |  392 lines
  1. ***PREAMBLE
  2. WinPack-TF uses a Virtual TNC - what appears to the user as
  3. the TNC responding to TNC2-style commands is, in fact, part
  4. of the software. The available Virtual TNC commands are:-
  5.  
  6. ***POSTAMBLE
  7.  
  8. Availability of some commands depends on whether you are
  9. using TF firmware, WA8DED firmware or TFEMU.
  10. Most commands can be abbreviated. The minimum abbreviation is
  11. shown in upper case.
  12. For help on a command use ?<command>. Example: ?DISPLAY
  13.  
  14. ***AUTOSSID
  15. Usage:-
  16. AUtoSSID ON or AUtoSSID OFF
  17. Default:-
  18. AUtoSSID OFF
  19. Purpose:-
  20. If AUtoSSID is on then an SSID is added to your callsign if you make
  21. an outgoing connect from a channel on the Terminal. The SSID is the
  22. same as the channel number, so if you make a connection from channel
  23. '2' your callsign will have an SSID of '2', etc. Outgoing connects
  24. from the main WinPack screen will not have an SSID.
  25.  
  26. ***BEACON
  27. Usage:-
  28. Beacon Every n
  29. Beacon After n
  30. n is a number between 0 and 250.
  31. Example:-
  32. Beacon Every 90
  33. Default:-
  34. Beacon Every 0  (disabled)
  35. Purpose:-
  36. Controls how frequently the beacon text (BText) is transmitted.
  37. "Beacon Every" sends BText every n*10 seconds, "Beacon After" sends
  38. BText only after n*10 seconds have passed with no packet activity on
  39. the frequency.
  40.  
  41. ***BTEXT
  42. Usage:-
  43. BText <text>
  44. <text> is from 1 to 80 characters and can contain Winpack tokens.
  45. Examples:-
  46. BText $MYCALL running $VERSION
  47. BText %  (this clears BText)
  48. Default:-
  49. No BText set.
  50. Purpose:-
  51. Specifies the text to be sent at the interval specified by Beacon. It
  52. is sent as an unproto frame to the address specified by the Unproto
  53. parameter.
  54.  
  55. ***CHancall
  56. Usage:-
  57. CHancall <callsign>
  58. Example:-
  59. Chancall G8MZX
  60. Purpose:-
  61. To temporarily change the callsign used on a channel. The callsign
  62. will be used until a connection and disconnection has occurred on that
  63. channel, at which point the channel callsign will revert to MYCALL.
  64.  
  65. ***CONNECT
  66. Usage:-
  67. Connect <call> [<call2> <call3>...]
  68. <call2>, <call3> etc. are optional digipeaters.
  69. Examples:-
  70. Connect G4IDE
  71. Connect G8MZX G4GZL
  72. Purpose:-
  73. Initiates a connect request. The result will be either a succesful
  74. connection being obtained, or a LINK FAILURE message.
  75.  
  76. ***CONSTAMP
  77. Usage:-
  78. CONStamp ON  or  CONStamp OFF
  79. Default:-
  80. CONStamp OFF
  81. Purpose:-
  82. Enables or disables time stamping of the connected and disconnected
  83. messages from the TNC. Please note - this command is not available
  84. with WA8DED firmware.
  85.  
  86. ***CONVERSE
  87. Usage:-
  88. CONVerse
  89. Purpose:-
  90. Put the Virtual TNC back into converse mode if you have used Ctrl_C
  91. to put it into command mode whilst you are connected. CONVerse is
  92. ignored if you aren't connected.
  93.  
  94. ***CTEXT
  95. Usage:-
  96. CText <text>
  97. <text> is from 1 to 80 characters and can contain Winpack tokens.
  98. Examples:-
  99. CText You are connected to a channel on a WinPack terminal.
  100. CText %  (this clears CText)
  101. Default:-
  102. CText Welcome to $VERSION. Sorry, no PMS facilities on this channel.
  103. Purpose:-
  104. Specifies the text that will be sent to stations connecting to a
  105. channel on the terminal screen, not to the the main WinPack system.
  106. See also WCText.
  107.  
  108. ***DIGIPEAT
  109. Usage:-
  110. DIGipeat ON  or  DIGipeat OFF
  111. Default:-
  112. DIGipeat ON
  113. Purpose:-
  114. Controls whether your station will act as a digipeater for traffic
  115. between other packet stations. Please note - this command is not
  116. available when using TFEMU.
  117.  
  118. ***DISCONNECT
  119. Usage:-
  120. Disconnect
  121. Purpose:-
  122. To disconnect a channel on which a connection exists.If there is no
  123. connection on the channel, the command is ignored. The TNC must first
  124. be put in command mode - you can put it in command mode by pressing
  125. Ctrl_C. You can also make a disconnect by using the Disconnect button,
  126. or by selection "Action", "Disconnect" on the main WinPack screen.
  127.  
  128. ***DISPLAY
  129. Usage:-
  130. DISPlay
  131. Purpose:-
  132. Generates a list of all control parameters and their values.
  133.  
  134. ***DWAIT
  135. Usage:-
  136. DWait n
  137. n is a number from 0 to 127.
  138. Example and Default:-
  139. DWait 16
  140. Purpose:-
  141. Specifies the length of time, in units of 10 milliseconds, that the
  142. TNC will wait before transmitting, to avoid collisions with digipeated
  143. packets. Please note - this command is not available with TF
  144. firmware or with TFEMU.
  145.  
  146. ***FRACK
  147. Usage:-
  148. FRack n
  149. n is a number between 1 and 15.
  150. Example and Default:-
  151. FRack 5
  152. Purpose:-
  153. To specify, in seconds, how long the TNC should wait for an
  154. acknowledgement of a frame before it sends the fram again. Please
  155. note - this command is not available when using TFEMU.
  156.  
  157. ***HELP
  158. Usage:-
  159. Help
  160. Purpose:-
  161. To show a list of the available Virtual TNC commands.
  162.  
  163. ***MAXFRAME
  164. Usage:-
  165. MAXframe n
  166. n is a number from 1 to 7.
  167. Example and Default:-
  168. MAXframe 2
  169. Purpose:-
  170. Sets a limit on the number of unacknowledged frames that will be
  171. allowed to be outstanding on a channel at any one time, and also the
  172. maximum number of frames that will ever be sent in one transmission on
  173. a channel.
  174.  
  175. ***MCOM
  176. Usage:-
  177. MCOM ON  or  MCOM OFF
  178. Default:-
  179. MCOM OFF
  180. Purpose:-
  181. Controls whether supervisory frames will be displayed in monitored
  182. traffic.
  183.  
  184. ***MHCLEAR
  185. Usage:-
  186. MHClear
  187. Purpose:-
  188. Clear the MHeard list - see also MHeard.
  189.  
  190. ***MHEARD
  191. Usage:-
  192. MHeard
  193. Purpose:-
  194. Display a list of stations heard by the TNC. Up to 16 stations will be
  195. displayed. The list shows callsigns and the date and time at which
  196. each station was last heard.
  197.  
  198. ***MONITOR
  199. Usage:-
  200. MONitor ON  or  MONitor OFF
  201. Default:-
  202. MONitor ON
  203. Purpose:-
  204. Controls whether monitoring of other traffic is enabled or disabled.
  205.  
  206. ***MSTAMP
  207. Usage:-
  208. MStamp ON  or  MStamp OFF
  209. Purpose:-
  210. Controls whether monitored frames are time and date stamp when they
  211. are displayed. Please note - this command is not available with
  212. WA8DED firmware.
  213.  
  214. ***MYCALL
  215. Usage:-
  216. MYcall <callsign>
  217. Example:-
  218. MYcall G4IDE
  219. Purpose:-
  220. To specify the callsign used by the TNC. If MYcall is changed whilst
  221. connections on other channels are in progess, the callsign being used
  222. on those channels is not affected.
  223.  
  224. ***PACLEN
  225. Usage:-
  226. Paclen n
  227. n is a number from 1 to 256.
  228. Example and Default:-
  229. Paclen 128
  230. Purpose:-
  231. To specify the maximum length of the data portion of any frame sent
  232. by the TNC.
  233.  
  234. ***PERSIST
  235. Usage:-
  236. PErsist n
  237. n is a number from 0 to 255.
  238. Example and Default:-
  239. PErsist 64
  240. Purpose:-
  241. Sets the probability that the TNC will send a queued frame if it finds
  242. the channel is clear. A value of 255 means it will definitely
  243. transmit, a value of 0 means it will never transmit. It is one of the
  244. two persistance timing parameters, the other is SLottime. Please note-
  245. this command is not available with WA8DED firmware or with TFEMU.
  246.  
  247. ***RAW
  248. Usage:-
  249. RAW <command>
  250. RAW <channel><command>
  251. Example:-
  252. RAW L
  253. RAW 0F7
  254. Purpose:-
  255. To send a raw command to the TNC. If the first character of the
  256. command is numeric then it is assumed to be a channel number, if it
  257. is a letter or '@' then the stream you are using is used for the
  258. channel number. DO NOT USE THIS COMMAND UNLESS YOU ARE SURE THAT YOU
  259. KNOW WHAT YOU ARE DOING AND YOU HAVE A GOOD KNOWLEDGE OF THE WA8DED
  260. AND TF2.7b COMMAND SET!!! The command may sometimes result in the
  261. response from the TNC appearing twice on the screen - this is
  262. unavoidable.
  263.  
  264. ***RESPTIME
  265. Usage:-
  266. RESPtime n
  267. n is a number from 0 to 255.
  268. Example and default:-
  269. RESPtime 150
  270. Purpose:-
  271. To specify the delay, in units of 10 milliseconds, between a frame
  272. being received and the acknowledgement being sent. The idea is to
  273. prevent collisions between the acknowledgement and another frame from
  274. the sending station. Please note - this command is not available when
  275. using TFEMU.
  276.  
  277. ***RPS
  278. Usage:-
  279. RPS
  280. Purpose:-
  281. Returns the number of times that the TNC goes round its internal cycle
  282. in one second.(Rounds Per Second). It is a comparitive measure of TNC
  283. performance. Please note - this command is not available with WA8DED
  284. firmware or with TFEMU.
  285.  
  286. ***SETTIME
  287. Usage:-
  288. SETtime
  289. Purpose:-
  290. Sets the TNC's internal time and date to the PC's time and date. The
  291. TNC uses the time and date for time stamping connections and monitored
  292. frames. SETtime is called automatically during TNC initialisation. See
  293. also CONStamp and MStamp. Please note - this command is not available
  294. with WA8DED firmware.
  295.  
  296. ***SLOTTIME
  297. Usage:-
  298. SLottime n
  299. n is a number from 0 to 255.
  300. Example and Default:-
  301. SLottime 100
  302. Purpose:-
  303. To set the frequency, in units of 1 millisecond, at which random
  304. numbers will be generated to determine if a queued frame will be
  305. transmitted if the channel is clear. It is one of the two persistance
  306. timing parameters, the other is PErsist. Please note - this command
  307. is not available with WA8DED firmware or with TFEMU.
  308.  
  309. ***TRIES
  310. Usage:-
  311. TRIes n
  312. n is a number from 0 to 15.
  313. Example and Default:-
  314. TRIes 10
  315. Purpose:-
  316. Specifies how many times the TNC will retry to send a frame before it
  317. gives up. Please note - this command is not available when using
  318. TFEMU.
  319.  
  320. ***TXDELAY
  321. Usage:-
  322. TXDelay n
  323. n is a number from 1 to 500.
  324. Example and Default:-
  325. TXDelay 30
  326. Purpose:-
  327. Specifies the delay, in units of 10 milliseconds (but see NOTE),
  328. between the push-to-talk being keyed and data being sent, to allow
  329. the rig to stabilise on transmit.
  330. I have been told that the SYMEK TNC3S TNC, which supports a version of
  331. TF, uses a unit of one millisecond for the TXDelay setting, which is
  332. why the upper limit of 500 is so high! The normal versions of TF and
  333. WA8DED will not accept a value above 127.
  334. Please note - this command is not available when using TFEMU.
  335.  
  336. ***UNPROTO
  337. Usage:-
  338. Unproto <call> [<call2> <call3>...]
  339. <call2>, <call3> etc. are optional digipeaters.
  340. Examples:-
  341. Unproto GB7IDE
  342. Unproto GB7OPC G8MZX
  343. Default:-
  344. Unproto CQ
  345. Purpose:-
  346. Specifies the address and optional digipeater callsigns to which
  347. unproto transmissions will be sent.
  348.  
  349. ***USERS
  350. Usage:-
  351. USers n
  352. n is a number from 0 to the maximum number of channels available on
  353. the TNC.
  354. Example:-
  355. USers 2
  356. Default:-
  357. The maximum number of channels available.
  358. Purpose:-
  359. To set the maximum number of simultaneous incoming connections allowed
  360. by the TNC. It does not restrict the number of outgoing connections
  361. that you can make.
  362.  
  363. ***VERSION
  364. Usage:-
  365. Version
  366. Purpose:-
  367. Returns the version of the firmware being used. Please note - this
  368. command is not available with WA8DED firmware, and some versions of TF
  369. may return the AX25 version being used (2) not the the firmware
  370. version.
  371.  
  372. ***WCTEXT
  373. Usage:-
  374. WCText <text>
  375. <text> is from 1 to 80 characters and can contain Winpack tokens.
  376. Examples:-
  377. WCText You are connected to a WinPack system.
  378. WCText %  (this clears WCText)
  379. Default:-
  380. Welcome to $VERSION. Send /h for help...
  381. Purpose:-
  382. Specifies the text that will be sent to stations connecting to the
  383. main WinPack system (channel 1 on the TNC). See also CText.
  384.  
  385. ***XMITOK
  386. Usage:-
  387. XMitok ON  or  XMitok OFF
  388. Purpose:-
  389. Specifies whether the TNC is allowed to transmit. Please note - this
  390. command is not available when using TFEMU.
  391.  
  392.